Получение списка департаментов клиента

Запрос позволяет получить список департаментов клиента.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/departments/list?
limit=<количество записей>
&offset=<количество пропускаемых записей>

Заголовки запроса

  • Authorization: Bearer <OAuth-токен>
    Процесс получения токена описан в разделе Начало работы.
  • X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос может содержать следующие необязательные параметры:

  • limit — количество выводимых записей. При отсутствии данного параметра возвращается информация о первых 100 записях.

  • offset — количество пропускаемых записей. При отсутствии данного параметра возвращается информация начиная с первой записи.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
items Список департаментов. Массив
limit Максимальное количество возвращаемых записей. Число
offset Количество пропущенных записей. Число
total_amount Количество найденных записей. Число

Структура элемента массива items:

Поле

Описание

Формат

id

id департамента.

Строка

name

Название департамента.

Строка

parent_id

id родительского департамента.

Строка

limits

Ограничения по сервисам на сумму, которую пользователи департамента могут потратить суммарно.
Указывается как объект со структурой {<сервис>: {"budget": <число>}, ...}.
Возможные значения сервисов:

  • taxi — такси,
  • eats2 — еда,
  • tanker — заправка.

Массив

Пример запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/departments/list?limit=100&offset=0
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "items": [
    {
      "id": "a8187621244340d890b684иииbf298276",
      "name": "Бухгалтеры",
      "limits": {
        "taxi": {
          "budget": 10000
        },
        "eats2": {
          "budget": null
        },
        "tanker": {
          "budget": null
        }
      },
      "parent_id": null
    }
  ],
  "limit": 100,
  "offset": 0,
  "total_amount": 1
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением.
  • 401 — был передан неверный OAuth-токен.
  • 403 — у клиента не хватает прав на выполнение данного запроса.
    • SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
    • SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
Предыдущая
Создание нового департамента
Следующая
Обновление данных о департаменте